Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better docstring coverage workflow from 2021 GA Hackathon #1981

Merged
merged 8 commits into from
Apr 27, 2022
Merged

Better docstring coverage workflow from 2021 GA Hackathon #1981

merged 8 commits into from
Apr 27, 2022

Conversation

epassaro
Copy link
Member

@epassaro epassaro commented Apr 25, 2022 •
edited
Loading

Description

Implementation the workflow I submitted to the 2021 GitHub Actions Hackathon on dev.to: https://github.com/epassaro/docstr-cov-workflow/

This workflow has some kind of approval from the developers of the docstr-coverage package.

Advantages:

  • Just one job, so no gray skipped jobs on GH web UI
  • More generic workflow, should work out of the box for any org/user. In this case we're using the tardis-bot username so required minor tweaking
  • Dynamic color badge

Motivation and context

How has this been tested?

  • Testing pipeline.
  • Other.

The coverage pipeline itself. Some steps requires merging to see if everything works.

Examples

Type of change

  • Bug fix.
  • New feature.
  • Breaking change.
  • None of the above.

Checklist

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
    • (optional) I have built the documentation on my fork following the instructions.
  • I have assigned and requested two reviewers for this pull request.

@epassaro epassaro marked this pull request as draft April 25, 2022 20:51
@codecov
Copy link

codecov bot commented Apr 25, 2022 •
edited
Loading

Codecov Report

Merging #1981 (ce37729) into master (01a018d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1981   +/-   ##
=======================================
  Coverage   59.85%   59.85%           
=======================================
  Files          70       70           
  Lines        8080     8080           
=======================================
  Hits         4836     4836           
  Misses       3244     3244

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@epassaro epassaro marked this pull request as ready for review April 25, 2022 22:02
@wkerzendorf wkerzendorf merged commit 0bac84c into tardis-sn:master Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
CI/CD documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@epassaro @wkerzendorf @andrewfullard